This introduces the concept of a Router with app-provided Route implementations that determine:

• Whether the location matches the Route
• Whether or not a location url should be routed through in-app navigation
• Any custom behavior to perform if the location url won't be navigated through in-app navigation (such as routing to an external browser, opening mailto: links, etc).

The Route interface looks like this:

    interface Route {
        /**
         * The configured app url. You can use this to determine if a location
         * exists on the same domain.
         */
        val appUrl get() = Hotwire.appUrl

        /**
         * The route name used in debug logging.
         */
        val name: String

        /**
         * To permit in-app navigation when the location matches this route,
         * return [RouteResult.NAVIGATE]. To prevent in-app navigation return
         * [RouteResult.STOP].
         */
        val result: RouteResult

        /**
         * Determines whether the location matches this route. Use your own custom
         * rules based on the location's domain, protocol, path, or any other
         * factors.
         */
        fun matches(location: String): Boolean

        /**
         * Perform custom routing behavior when a match is found. For example,
         * open an external browser or app for external domain urls.
         */
        fun perform(location: String, activity: AppCompatActivity)
    }

Before performing an in-app navigation visit, TurboNavigator routes the location url through the app router. The router loops over each registered Route until it gets a match (the order of the registered routes determine in what order they're processed). The matched Route must return one of either:

• RouteResult.NAVIGATE: Informs the navigator to continue performing the in-app navigation visit.
• RouteResult.STOP: Informs the navigator to stop the in-app navigation visit. The Route can provide its own custom behavior, such as opening an external browser.

There are three built-in Routes that can be used by applications

• AppNavigationRoute: Allows locations urls on the same domain as Hotwire.appUrl to navigate within the app.
• BrowserRoute: Allows location urls on a different domain from Hotwire.appUrl to stop in-app navigation and route the url to an external browser.
• BrowserTabRoute: Allows location urls on a different domain as Hotwire.appUrl to stop in-app navigation and route the url to a browser Custom Tab.

By default, AppNavigationRoute and BrowserRoute are registered. The routes that an application uses can be configured by calling Hotwire.registerRoutes(routes). Applications can create their own Route implementations by implementing the Route interface and registering the route.